home *** CD-ROM | disk | FTP | other *** search
/ Best of Shareware / Best of PC Windows Shareware 1.0 - Wayzata Technology (7111) (1993).iso / mac / WINDOWS / TELECOMM / MWCH21 / MWATCH.TXT < prev    next >
Text File  |  1992-12-01  |  15KB  |  377 lines
  1.                           MailWatch
  2.                          version 2.1
  3.                         by Jon Glazer
  4.                {glazer@ohstpy.mps.ohio-state}
  5.                      Copyright (c) 1992
  6.  
  7.  
  8. Introduction:
  9.  
  10. MailWatch is an email management program designed to give
  11. comprehensive reports about your email system and perform
  12. some management functions to help reduce the amount of space
  13. it utilizes.  MailWatch has the ability to actually re-send
  14. unread mail to an alternative address to ensure that old
  15. mail does not continually build up on your system.
  16. MailWatch is designed to work with Pegasus Mail by David
  17. Harris and Charon by Brad Clements.  Both of these are
  18. readily available off of most network sourced BBS systems
  19. and Compuserve.  Future versions of MailWatch will also
  20. support MHS and possibly other email packages.
  21.  
  22. This document will assume that the reader has a good
  23. understanding of Pegasus Mail and Charon and at least some
  24. rudimentary knowledge of basic Novell functions.
  25.  
  26. History:
  27.                               
  28. .92b Final release of test version.
  29. 2.0  First release of rewritten shareware version.
  30. 2.1  Major bug fix release
  31.      - Fixed numerous bugs regarding forwarding mail.
  32.      - Fixed directory search algorythm to eliminate Novell
  33.       errors.
  34.      - Added support for return-to-sender and corrected
  35.       forwarding  algorythm to work as-stated (see
  36.       RetunAdd).
  37.      - Modified initial search to read from bindary rather
  38.       than SYS:MAIL.  Names are now read directly, converted
  39.       to their HEX IDs then used to search for mail.
  40.       Formerly, all directories under SYS:MAIL were
  41.       searched, valid or not.
  42.      - Added "Z" report for primitive dump of user
  43.       preference settings.
  44.      - Corrected a variety of errors regarding incorrect
  45.       mail counts and inaccurate reports.
  46.      - Added a total at the bottom of each numeric column.
  47.      - Added banner info for email in MAILQUEUE when sending
  48.       mail via Charon (real important huh?).
  49.  
  50. Installation:
  51.  
  52. Place the MailWatch distribution files (*.EXE and *.INI at
  53. least) in any directory in your path.  It might be
  54. convenient to place the in the same directory as PMAIL.
  55.  
  56. MWATCH.INI contains many user-settable variables that will
  57. define how MailWatch performs its various tasks.  MailWatch
  58. cannot operate properly without finding MWATCH.INI in the
  59. path or current directory.
  60.  
  61. The user who runs MailWatch should have full access to the
  62. mail root directory.  This is necessary to be able to
  63. accurately scan all of the mail subdirectories and
  64. delete/forward mail as needed.
  65.  
  66. MWATCH.INI
  67.  
  68. MWATCH.INI conforms to the standard section/keyword/value
  69. format that is found in many other applications such as
  70. Windows.  The .INI format is exceedingly easy to understand
  71. and manipulate and should make the more advance MailWatch
  72. features more easily understandable.
  73.  
  74. MWATCH.INI is broken into three types of sections, [system],
  75. [global], and [other profiles].
  76.  
  77. [system]
  78.  
  79. Variables under this section define various system settings
  80. needed to tell MailWatch about your particular network and
  81. email system.
  82.      
  83. MailDir= This variable defines the root mail directory of
  84.      the email system.  For most Novell networks running
  85.      Pegasus Mail this is SYS:MAIL, however the volume name
  86.      "SYS" may change depending upon your installation.  If
  87.      this variable is not defined, SYS:MAIL is assumed.
  88.  
  89. LogFile= Enter the name of the log file you wish to use to
  90.      maintain a log of the activities MailWatch performs.
  91.      If you do not define a log file name, no log will be
  92.      kept.
  93.  
  94. LogSize= Log files can build in size forever until your disk
  95.      is full unless you periodically delete them or set a
  96.      limit.  LogSize defines the maximum number of bytes the
  97.      log file can get before logging is suspended.  By
  98.      default, a size of 1024000 (1 meg) is assumed.
  99.  
  100. Default= You can define a default profile to use if you do
  101.      not specify one on the command line by entering a valid
  102.      profile name in this  variable.
  103.  
  104. Registration= MailWatch is not a free utility.  By
  105.      registering the product (paying for it) you will
  106.      receive a passcode that will enable the restricted
  107.      features of MailWatch.  Enter the passcode here to tell
  108.      MailWatch that it is now registered.  See the section
  109.      entitled REGISTRATION for more information.
  110.  
  111. [global]
  112.  
  113. Sections other than [system] define parameters to use when
  114. running MailWatch.  MailWatch will search MWATCH.INI for
  115. each variable, first in the given profile section then, if
  116. not found, it will look in the [global] section for these
  117. variables before using defaults or erroring.  The following
  118. variables are valid profile settings that may or may not be
  119. appropriate for the [global] section.  This is where some
  120. logic in the design of MWATCH.INI will be needed.
  121.  
  122. NewMail= New, unread mail, is stored in separate files in a
  123.      user's mail directory with the extension .CNM (or at
  124.      least it is for Pegasus Mail delivered by Charon or
  125.      Pegasus).  This variable allows you to define what
  126.      extension to scan for new mail.  Usually this would
  127.      simply be *.CNM (and, in fact, is the default) but it
  128.      is provided here in case you find some other use for
  129.      MailWatch I cannot conceive of (or perhaps some other
  130.      email package can use this utility?).
  131.  
  132. Age= MailWatch performs functions and reports on aged mail.
  133.      This is mail that is older than a defined number of
  134.      days (usually unread mail).  Enter a number here that
  135.      defines what is to be considered aged mail.  There is
  136.      usually no reason to place this in the [global]
  137.      section, nor is there a default value.  Age must be
  138.      specified explicitly for MailWatch to function.
  139.  
  140. Name= You may have MailWatch perform functions on the entire
  141.      mail system, or you can have it work on only selected
  142.      users.  Enter the name of the user you wish to scan in
  143.      this variable.  You may use wildcards if you wish to
  144.      scan groups of names (such as all users with "J" as a
  145.      first letter Name=J*).
  146.  
  147. ReturnAdd= Aged mail can be forwarded to another user or to
  148.      the same user on another host or return the message to
  149.      the sender..  Reasons for doing this are: 1) if a user
  150.      has old, unread mail, send the mail to the email
  151.      administrator to sort out why the mail has not been
  152.      read (notify the user).  2) if the user usually works
  153.      from a Unix host (or some other foreign host) send the
  154.      mail there.  The user may not have enabled AutoForward.
  155.      The mail will be rather old when he/she receives it and
  156.      hopefully he/she will correct the entry in AutoForward
  157.      to avoid this problem in the future.
  158.  
  159.      To have the mail sent to a different user, enter the
  160.      full address of the user to send old mail to.  If you
  161.      wish to simply have the mail sent to the same user on
  162.      another host, enter the mail path w/o the username and
  163.      the addressee will be added by MailWatch.  Ex..
  164.      ReturnAdd=@novell.com will send aged mail to the
  165.      {addressee}@novell.com.
  166.  
  167.      If no value is given for ReturnAdd then the aged mail
  168.      will be returned to sender with the appropriate message
  169.      in the subject.
  170.  
  171. OutputName= When generating reports, MailWatch can send the
  172.      report to a file.  Enter the name of the file you wish
  173.      to use for your report output.  No default is provided.
  174.  
  175. LineDraw= (Yes/No)  Reports can be generated using either
  176.      the PC linedraw characters or dashes and plusses.  Some
  177.      printers cannot print the linedraw characters.  The
  178.      default is no.
  179.  
  180. PageLength= Enter the length of a single page of output for
  181.      reports.  By default this is 60 lines.
  182.  
  183. DeleteAged= (Yes/No) When aged mail is encountered, should
  184.      it be deleted after processing (i.e., after the report
  185.      is generated or after it is forwarded).  If mail is
  186.      forwarded and not deleted, then the next time MailWatch
  187.      is run a duplicate mail message will be forwarded until
  188.      the mail is deleted.
  189.  
  190. ForwardAged= (Yes/No)  Should aged, unread mail be forwarded
  191.      to ReturnAdd?
  192.  
  193. AgedGroup= MailWatch has the ability to maintain a Novell
  194.      group of users who have unread, aged mail.  By placing
  195.      usernames in this group, you can give notice to these
  196.      users that their mail is being ignored and that it may
  197.      eventually be deleted.  This can be easily done in the
  198.      login script (see Novell documentation).  By running
  199.      consecutive scans, you can provide different messages
  200.      to users such as "You have mail older than 10 days
  201.      waiting". "You have mail older than 20 days waiting",
  202.      "Your unread mail is being deleted" etc....  Provide
  203.      AgedGroup with the name of the group to maintain the
  204.      names in.  This group should already be created.  Each
  205.      time MailWatch is run, it is cleared of names and
  206.      updated with only those that have been processed.
  207.  
  208. ExcludeGroup= You can provide a list of users to exclude
  209.      from MailWatch processing by giving the name of an
  210.      existing Novell group here.  Users found in that group
  211.      will be ignored by MailWatch.
  212.  
  213. Quiet= (0,1,2) This tells MailWatch how much status to
  214.      display when executing.  A quiet level of 0 will
  215.      display everything (not quiet).  This can result in a
  216.      rather messy display but it does allow for redirection
  217.      of output in the event you wish to have information
  218.      generated by reports piped into another application.
  219.      Quiet level 1 (sort of quiet) will generate a series of
  220.      colored dots that show status.  The various colors
  221.      signify different activities and are only provided to
  222.      make the display interesting.  Quiet level 2 (tight
  223.      lipped) does not display anything at all unless an
  224.      error is encountered.
  225.  
  226. RepOrder= This is a rather complex variable.  Basically it
  227.      provides MailWatch with the information you wish to see
  228.      on a report.  Reports are usually made of columns of
  229.      information.  Some of the information may not be wanted
  230.      or may need to be in a particular order.  Each column
  231.      of information has an associated letter.  Enter in
  232.      RepOrder the column order you wish to see in the
  233.      reports.  This is simply a set of letters that turn on
  234.      report columns and tell MailWatch to print them in a
  235.      particular order.  See the REPORTS section for more
  236.      information.
  237.  
  238. [Other Profiles]
  239.  
  240. Additional should be defined with the above variable to
  241. describe various MailWatch functions.  Examples might be
  242. sections to simply delete old mail, forward and delete old
  243. mail, generate specific reports, or any combination of
  244. these.  You would run MailWatch with the name of the profile
  245. on the command line to have it use those values when
  246. running.   If you do not provide a profile name, the one
  247. found in Default= in the [system] section will be used , if
  248. available.
  249.  
  250. Reports:
  251.  
  252. MailWatch has a rather sophisticated reporting system.  It
  253. provides information as desired and limits its processing to
  254. only those areas required to acquire this information.  In
  255. this way, MailWatch processing times may vary depending upon
  256. the type and quantity of information requested.
  257.  
  258. Each report is made up of columns of information.  Each
  259. column item has a corresponding column letter assigned to
  260. it.  When generating reports, the columns are displayed in
  261. the order provided in the RepOrder variable.  If a column is
  262. excluded from this variable, it will not be displayed at
  263. all.
  264.  
  265. The following is a description of each of the available
  266. reporting columns you may include in RepOrder.
  267.  
  268.   General     Pmail      Unread       MHS         Folder
  269. A Userid   C  Total    G Unread    K  MHS      O  Folder
  270.               Email      Total        Total       Total
  271. B User     D  Total    H Unread    L  MHS Size P  Folder
  272.   Name        Aged       Size                     Size
  273.            E  Total    I Unread    M  MHS Aged Q  Folder
  274.               Size       Aged                     Deleted
  275.            F  Total    J Unread    N  MHS      R  Folder
  276.               ASize      ASize        Asize       Mail
  277.                                                S  Folder
  278.                                                   Aged
  279.                                                T  *Folder
  280.                                                   Name
  281. * Requires special consideration (See below).
  282.  
  283. The General columns are general information pertaining to
  284. the email user.
  285.  
  286. Items under Pmail depict information regarding specific
  287. elements of Pegasus Mail mail.  Totals in this category
  288. total both read and unread mail.
  289.  
  290. The Unread category also deals with Pegasus Mail
  291. information.  These are statistics about unread mail found.
  292.  
  293. MHS statistics are not yet available but will be active
  294. using these settings eventually.
  295.  
  296. Folder statistics can be taken if you wish to get that level
  297. of information.  If you specify that the folder name is to
  298. be displayed (not usually useful) than another type of
  299. report will be generated giving sub totals for the folder
  300. information.  This can become rather cluttered and is only
  301. offered as a service for debugging.
  302.  
  303. ASize information depicts aged, unread mail sizes.
  304.  
  305. Example
  306.  
  307. If RepOrder=ABCGOE then the report would be UserId,
  308. UserName, TotalEmail, UnreadTotal, FolderTotal, TotalSize in
  309. that order.
  310.  
  311. An additional report code of "Z" will dump user settings for
  312. Pegasus Mail.  This should probably be used alone in it's
  313. own profile, otherwise a rather cluttered, and unreadable
  314. report will be generated.
  315.  
  316. Example
  317.  
  318. RepOrder=Z
  319.  
  320. Disclaimer:
  321.  
  322. This product is distributed "as-is".  Loss or corruption of
  323. data  or damage to equipment due directly or indirectly to
  324. the use of this product is not the responsibility of the
  325. author who cannot be made liable.  Use this product at your
  326. own risk.
  327.  
  328. Credits:
  329. Pegasus Mail is copyright by David Harris.
  330. Charon is copyright by Brad Clements.
  331. Novell is a trademark of Novell Inc.
  332. Windows is a trademark of Microsoft Inc.
  333.  
  334. Registration:
  335.  
  336. MailWatch is not free.  It has been developed after a
  337. considerable amount of effort and is distributed in the
  338. shareware fashion.  If you decide that MailWatch is useful
  339. for you, please send $39 to:
  340.  
  341.           Jon Glazer
  342.           2097 Brittany Road
  343.           Columbus, Oh   43229.
  344.  
  345. Questions and comments can be sent to glazer@ohstpy.mps.ohio-
  346. state.edu.
  347.  
  348. You will receive a passcode that will enable any MailWatch
  349. protected features.  This code will be good for any
  350. maintenance releases of MailWatch in the future.  A
  351. maintenance release is a version whose minor number changes
  352. (i.e. 2.01, 2.02, 2.10 etc..).
  353.  
  354. Please complete and send the following form:
  355.  
  356. Please send me the MailWatch passcode via:
  357.  
  358. [  ] U.S. Mail                address
  359.  
  360.           ________________________________________
  361.  
  362.           ________________________________________
  363.  
  364.           ________________________________________
  365.  
  366.           ________________________________________
  367.  
  368.  
  369. [  ] Internet (email) , my address is:
  370.  
  371.      _______________________________________________
  372.  
  373.  
  374. [  ] Compuserve (email), my id is:
  375.  
  376.      _______________________________________________
  377.